<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: contrib/sIPOPT/src/SensBuilder.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.17</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('SensBuilder_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">SensBuilder.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="SensBuilder_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright 2009, 2011 Hans Pirnay</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">// All Rights Reserved.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// This code is published under the Eclipse Public License.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">//</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">// Date   : 2009-05-10</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef __ASSCHURBUILDER_HPP__</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define __ASSCHURBUILDER_HPP__</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &quot;<a class="code" href="IpReferenced_8hpp.html">IpReferenced.hpp</a>&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#include &quot;<a class="code" href="SensAlgorithm_8hpp.html">SensAlgorithm.hpp</a>&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#include &quot;<a class="code" href="IpPDSystemSolver_8hpp.html">IpPDSystemSolver.hpp</a>&quot;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="preprocessor">#include &quot;<a class="code" href="SensUtils_8hpp.html">SensUtils.hpp</a>&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#include &quot;<a class="code" href="SensReducedHessianCalculator_8hpp.html">SensReducedHessianCalculator.hpp</a>&quot;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceIpopt.html">Ipopt</a></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span>{</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="namespaceIpopt.html#ad00d34c37128c8a05abc0561539594e4">   18</a></span><a class="code hl_define" href="SensUtils_8hpp.html#ad63949cc73e4271b72a6d80e0625ff88">DECLARE_STD_SIPOPT_EXCEPTION</a>(SENS_BUILDER_ERROR);</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span> </div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="classIpopt_1_1SensBuilder.html">   20</a></span><span class="keyword">class </span><a class="code hl_class" href="classIpopt_1_1SensBuilder.html">SensBuilder</a>: <span class="keyword">public</span> <a class="code hl_class" href="classIpopt_1_1ReferencedObject.html">ReferencedObject</a></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span>{</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classIpopt_1_1SensBuilder.html#ac314c96662e24e694fd7b5aaad9be387">   26</a></span>   <a class="code hl_function" href="classIpopt_1_1SensBuilder.html#ac314c96662e24e694fd7b5aaad9be387">SensBuilder</a>();</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classIpopt_1_1SensBuilder.html#a6ead46a9ee07e48670c315cf828fb848">   28</a></span>   <a class="code hl_function" href="classIpopt_1_1SensBuilder.html#a6ead46a9ee07e48670c315cf828fb848">~SensBuilder</a>();</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classIpopt_1_1SensBuilder.html#a27c70247d1720673f9ea7a1bfa755d07">   30</a></span>   <a class="code hl_class" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;SensAlgorithm&gt;</a> <a class="code hl_function" href="classIpopt_1_1SensBuilder.html#a27c70247d1720673f9ea7a1bfa755d07">BuildSensAlg</a>(</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1Journalist.html">Journalist</a>&amp;          jnlst,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1OptionsList.html">OptionsList</a>&amp;         options,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>      <span class="keyword">const</span> std::string&amp;         prefix,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>      <a class="code hl_class" href="classIpopt_1_1IpoptNLP.html">IpoptNLP</a>&amp;                  ip_nlp,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>      <a class="code hl_class" href="classIpopt_1_1IpoptData.html">IpoptData</a>&amp;                 ip_data,</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>      <a class="code hl_class" href="classIpopt_1_1IpoptCalculatedQuantities.html">IpoptCalculatedQuantities</a>&amp; ip_cq,</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>      <a class="code hl_class" href="classIpopt_1_1PDSystemSolver.html">PDSystemSolver</a>&amp;            pd_solver</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>   );</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classIpopt_1_1SensBuilder.html#af3a62e5c1b130474548fb599b788f997">   40</a></span>   <a class="code hl_class" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;ReducedHessianCalculator&gt;</a> <a class="code hl_function" href="classIpopt_1_1SensBuilder.html#af3a62e5c1b130474548fb599b788f997">BuildRedHessCalc</a>(</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1Journalist.html">Journalist</a>&amp;          jnlst,</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1OptionsList.html">OptionsList</a>&amp;         options,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>      <span class="keyword">const</span> std::string&amp;         prefix,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>      <a class="code hl_class" href="classIpopt_1_1IpoptNLP.html">IpoptNLP</a>&amp;                  ip_nlp,</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>      <a class="code hl_class" href="classIpopt_1_1IpoptData.html">IpoptData</a>&amp;                 ip_data,</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>      <a class="code hl_class" href="classIpopt_1_1IpoptCalculatedQuantities.html">IpoptCalculatedQuantities</a>&amp; ip_cq,</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>      <a class="code hl_class" href="classIpopt_1_1PDSystemSolver.html">PDSystemSolver</a>&amp;            pd_solver</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>   );</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>};</div>
</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>}</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aIpPDSystemSolver_8hpp_html"><div class="ttname"><a href="IpPDSystemSolver_8hpp.html">IpPDSystemSolver.hpp</a></div></div>
<div class="ttc" id="aIpReferenced_8hpp_html"><div class="ttname"><a href="IpReferenced_8hpp.html">IpReferenced.hpp</a></div></div>
<div class="ttc" id="aSensAlgorithm_8hpp_html"><div class="ttname"><a href="SensAlgorithm_8hpp.html">SensAlgorithm.hpp</a></div></div>
<div class="ttc" id="aSensReducedHessianCalculator_8hpp_html"><div class="ttname"><a href="SensReducedHessianCalculator_8hpp.html">SensReducedHessianCalculator.hpp</a></div></div>
<div class="ttc" id="aSensUtils_8hpp_html"><div class="ttname"><a href="SensUtils_8hpp.html">SensUtils.hpp</a></div></div>
<div class="ttc" id="aSensUtils_8hpp_html_ad63949cc73e4271b72a6d80e0625ff88"><div class="ttname"><a href="SensUtils_8hpp.html#ad63949cc73e4271b72a6d80e0625ff88">DECLARE_STD_SIPOPT_EXCEPTION</a></div><div class="ttdeci">#define DECLARE_STD_SIPOPT_EXCEPTION(__except_type)</div><div class="ttdef"><b>Definition</b> <a href="SensUtils_8hpp_source.html#l00050">SensUtils.hpp:50</a></div></div>
<div class="ttc" id="aclassIpopt_1_1IpoptCalculatedQuantities_html"><div class="ttname"><a href="classIpopt_1_1IpoptCalculatedQuantities.html">Ipopt::IpoptCalculatedQuantities</a></div><div class="ttdoc">Class for all IPOPT specific calculated quantities.</div><div class="ttdef"><b>Definition</b> <a href="IpIpoptCalculatedQuantities_8hpp_source.html#l00086">IpIpoptCalculatedQuantities.hpp:87</a></div></div>
<div class="ttc" id="aclassIpopt_1_1IpoptData_html"><div class="ttname"><a href="classIpopt_1_1IpoptData.html">Ipopt::IpoptData</a></div><div class="ttdoc">Class to organize all the data required by the algorithm.</div><div class="ttdef"><b>Definition</b> <a href="IpIpoptData_8hpp_source.html#l00100">IpIpoptData.hpp:101</a></div></div>
<div class="ttc" id="aclassIpopt_1_1IpoptNLP_html"><div class="ttname"><a href="classIpopt_1_1IpoptNLP.html">Ipopt::IpoptNLP</a></div><div class="ttdoc">This is the abstract base class for classes that map the traditional NLP into something that is more ...</div><div class="ttdef"><b>Definition</b> <a href="IpIpoptNLP_8hpp_source.html#l00035">IpIpoptNLP.hpp:36</a></div></div>
<div class="ttc" id="aclassIpopt_1_1Journalist_html"><div class="ttname"><a href="classIpopt_1_1Journalist.html">Ipopt::Journalist</a></div><div class="ttdoc">Class responsible for all message output.</div><div class="ttdef"><b>Definition</b> <a href="IpJournalist_8hpp_source.html#l00116">IpJournalist.hpp:117</a></div></div>
<div class="ttc" id="aclassIpopt_1_1OptionsList_html"><div class="ttname"><a href="classIpopt_1_1OptionsList.html">Ipopt::OptionsList</a></div><div class="ttdoc">This class stores a list of user set options.</div><div class="ttdef"><b>Definition</b> <a href="IpOptionsList_8hpp_source.html#l00032">IpOptionsList.hpp:33</a></div></div>
<div class="ttc" id="aclassIpopt_1_1PDSystemSolver_html"><div class="ttname"><a href="classIpopt_1_1PDSystemSolver.html">Ipopt::PDSystemSolver</a></div><div class="ttdoc">Pure Primal Dual System Solver Base Class.</div><div class="ttdef"><b>Definition</b> <a href="IpPDSystemSolver_8hpp_source.html#l00074">IpPDSystemSolver.hpp:75</a></div></div>
<div class="ttc" id="aclassIpopt_1_1ReferencedObject_html"><div class="ttname"><a href="classIpopt_1_1ReferencedObject.html">Ipopt::ReferencedObject</a></div><div class="ttdoc">Storing the reference count of all the smart pointers that currently reference it.</div><div class="ttdef"><b>Definition</b> <a href="IpReferenced_8hpp_source.html#l00169">IpReferenced.hpp:170</a></div></div>
<div class="ttc" id="aclassIpopt_1_1SensBuilder_html"><div class="ttname"><a href="classIpopt_1_1SensBuilder.html">Ipopt::SensBuilder</a></div><div class="ttdef"><b>Definition</b> <a href="SensBuilder_8hpp_source.html#l00020">SensBuilder.hpp:21</a></div></div>
<div class="ttc" id="aclassIpopt_1_1SensBuilder_html_a27c70247d1720673f9ea7a1bfa755d07"><div class="ttname"><a href="classIpopt_1_1SensBuilder.html#a27c70247d1720673f9ea7a1bfa755d07">Ipopt::SensBuilder::BuildSensAlg</a></div><div class="ttdeci">SmartPtr&lt; SensAlgorithm &gt; BuildSensAlg(const Journalist &amp;jnlst, const OptionsList &amp;options, const std::string &amp;prefix, IpoptNLP &amp;ip_nlp, IpoptData &amp;ip_data, IpoptCalculatedQuantities &amp;ip_cq, PDSystemSolver &amp;pd_solver)</div></div>
<div class="ttc" id="aclassIpopt_1_1SensBuilder_html_a6ead46a9ee07e48670c315cf828fb848"><div class="ttname"><a href="classIpopt_1_1SensBuilder.html#a6ead46a9ee07e48670c315cf828fb848">Ipopt::SensBuilder::~SensBuilder</a></div><div class="ttdeci">~SensBuilder()</div></div>
<div class="ttc" id="aclassIpopt_1_1SensBuilder_html_ac314c96662e24e694fd7b5aaad9be387"><div class="ttname"><a href="classIpopt_1_1SensBuilder.html#ac314c96662e24e694fd7b5aaad9be387">Ipopt::SensBuilder::SensBuilder</a></div><div class="ttdeci">SensBuilder()</div><div class="ttdoc">This class sets up everything necessary and builds the P matrix which is an intermediate step in calc...</div></div>
<div class="ttc" id="aclassIpopt_1_1SensBuilder_html_af3a62e5c1b130474548fb599b788f997"><div class="ttname"><a href="classIpopt_1_1SensBuilder.html#af3a62e5c1b130474548fb599b788f997">Ipopt::SensBuilder::BuildRedHessCalc</a></div><div class="ttdeci">SmartPtr&lt; ReducedHessianCalculator &gt; BuildRedHessCalc(const Journalist &amp;jnlst, const OptionsList &amp;options, const std::string &amp;prefix, IpoptNLP &amp;ip_nlp, IpoptData &amp;ip_data, IpoptCalculatedQuantities &amp;ip_cq, PDSystemSolver &amp;pd_solver)</div></div>
<div class="ttc" id="aclassIpopt_1_1SmartPtr_html"><div class="ttname"><a href="classIpopt_1_1SmartPtr.html">Ipopt::SmartPtr</a></div><div class="ttdoc">Template class for Smart Pointers.</div><div class="ttdef"><b>Definition</b> <a href="IpSmartPtr_8hpp_source.html#l00164">IpSmartPtr.hpp:165</a></div></div>
<div class="ttc" id="anamespaceIpopt_html"><div class="ttname"><a href="namespaceIpopt.html">Ipopt</a></div><div class="ttdoc">This file contains a base class for all exceptions and a set of macros to help with exceptions.</div><div class="ttdef"><b>Definition</b> <a href="IpInexactAlgBuilder_8hpp_source.html#l00013">IpInexactAlgBuilder.hpp:14</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>
